home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / prfp100.zip / PRFP.DOC < prev    next >
Text File  |  1993-01-17  |  9KB  |  179 lines
  1.   
  2.  
  3.               PRFP 1.00 - The Pseudo-Random File Picker
  4.                       Copyright 1993, Bert Edens
  5.                          All Rights Reserved
  6.  
  7.  
  8. What is PRFP? (or, why bother with a random file picker?)
  9.    
  10.    PRFP is a utility that will use a specified configuration file to 
  11.    pick random files. PRFP was developed due to the lack of utilities 
  12.    available to select random files for menus and such on my BBS. 
  13.    There are a couple of utilities available, but they are much more 
  14.    limited than PRFP. I could have made PRFP allow unlimited files to 
  15.    choose from, but as a sysop, I know that I wouldn't want to deal with 
  16.    more than 700 ANSI files so that's the limit. One of the things I 
  17.    like about PRFP is you don't have to tell it in advance how many files 
  18.    it has to choose from. I figure a program should be smart enough to 
  19.    know how to count. :)
  20.  
  21. Configuration Information, etc. (or, how to make this puppy work)
  22.  
  23.    PRFP is controlled by a configuration file that is a simple sequential
  24.    text file. The default filename that PRFP looks for is PRFP.CFG. This 
  25.    file must be in the current directory. You can also specify a 
  26.    configuration filename at the command line by typing:
  27.      
  28.       PRFP <filename>
  29.  
  30.    This is one way to specify a file that is not in the current directory.
  31.    PRFP will allow full pathnames. So, you could enter:
  32.      
  33.       PRFP C:\CONFIGS\PRFP0001.CFG
  34.  
  35.    if you wanted and, providing the file actually existed, PRFP would find
  36.    it. PRFP has three basic line formats that it can read from the config
  37.    file:
  38.  
  39.    (1)  . <Extensions to be copied>
  40.  
  41.         With this format, you can specify which extensions are to be copied
  42.         to the destination filename (see below). There MUST be a space 
  43.         between the "." and the extensions for PRFP to operate properly. 
  44.         Each extension should NOT have a leading ".". For example, if you 
  45.         wanted to copy three extensions: "ASC", "ANS", and "AVT", the 
  46.         line would look like:
  47.             
  48.            . ASC ANS AVT
  49.  
  50.         Only ONE "." line can be specified per file. Generally, if you are
  51.         copying files such as screens, the extensions would be consistent.
  52.         If there is enough demand for it, I may implement more flexibility
  53.         here.
  54.             
  55.    (2)  * <Destination filename>
  56.  
  57.         With this format, PRFP will load in the specified filename as the
  58.         current filename that the picked files are to be copied to. There
  59.         MUST be a space between the "*" and the filename. If not, PRFP will
  60.         not operate properly. You must also exclude the extension from the 
  61.         filename. Full paths may be used as long as the extension is not.
  62.         An example of what this line might look like is:
  63.             
  64.            * C:\RA\TXTFILES\WELCOME
  65.  
  66.         Everytime a "*" line is encountered, PRFP will begin storing files
  67.         for the new destination filename. Up to 100 destination filenames 
  68.         may be defined.
  69.  
  70.    (3)  <Filenames>
  71.  
  72.         Any non-blank line that does not begin with "*" or "." will be 
  73.         assumed to be a filename that is to be added to the list of files
  74.         to be chosen from. A sample line might look like:
  75.             
  76.            C:\RA\TXTFILES\WELCOM01
  77.         
  78.         Up to 700 filenames and destination filenames COMBINED may be used.
  79.         At the very most (assuming someone would actually HAVE that many 
  80.         files to pick from :-), you could have 100 destination filenames and
  81.         600 files to choose from. You could also have 1 destination filename
  82.         and 699 files to choose from. As long as the total number of files
  83.         does not exceed 700 (and the number of destination filenames does 
  84.         not exceed 100 as stated above), you are in good shape. PRFP HAS been
  85.         tested with one destination filename and 699 files to choose from and
  86.         it DOES work. By the way, the smallest window I could get PRFP to run
  87.         in was 211K. That held true whether I had to choose from 699 files
  88.         or just 2.
  89.  
  90.    A sample configuration filename might look like (the display is indented 
  91.    for COSMETIC PURPOSES ONLY; ALL CONFIG FILE LINES SHOULD START IN COLUMN
  92.      ONE):
  93.  
  94.       . ASC ANS AVT
  95.       * C:\RA\TXTFILES\WELCOME
  96.       C:\RA\TXTFILES\WELCOM01
  97.       C:\RA\TXTFILES\WELCOM02
  98.       C:\RA\TXTFILES\WELCOM03
  99.  
  100.    A sample PRFP.CFG has been included in this archive for your benefit. 
  101.  
  102. Error handling, etc. (or, other miscellaneous technical rot)
  103.  
  104.    PRFP has been designed to behave very specifically. It will notify you 
  105.    if one of the files you have specified to be chosen from does not exist
  106.    (with the appropriate extension attached). It will also notify you if it
  107.    can not find the specified configuration file (whether it be user-defined
  108.    or the default PRFP.CFG). When PRFP copies a file, the destination file
  109.    becomes identical to the chosen file, right down to the file date and 
  110.    time. If anyone requests the change, I will consider changing it so that 
  111.    the destination file date and time will be "touched" to the current date
  112.    and time.
  113.  
  114. Bug Reports, etc. (or, how to contact the guy who wrote this thing)
  115.  
  116.    As of January 1993, I am located in Springdale, Arkansas, USA. My current
  117.    FidoNet address is 1:391/1160. If you're a FamilyNet person, it's 
  118.    8:391/1160. Regardless, you can always find me in the FidoNet nodelist as
  119.    "Bert_Edens". I run a 24 hour BBS, so netmail to me should be no problem.
  120.  
  121. Thanks, etc. (or, who should be mentioned for legal sakes)
  122.  
  123.    - PRFP 1.00, the Pseudo-Random File Picker was written using Borland's 
  124.      Turbo Pascal 6.0. 
  125.      
  126.     *************************************************************
  127.     *                                                           *
  128.     *   A big thanks to Professor Timo Salami of University of  *
  129.     *  Vaasa, Finland, for the use of some of his Turbo Pascal  *
  130.     *     routines. Without them, PRFP would not be the same    *
  131.     *   as it is now. You can find these great routines on the  *
  132.     *         Internet at garbo.uwasa.fi, or stateside at       *
  133.     *  wuarchive.wustl.edu under the filename TSPA*.ZIP, where  *
  134.     *  the wildcard is the current revision of the routines and *
  135.     *   the version of Turbo Pascal that the routines are for.  *
  136.     *  For example, version 30 of the routines for Turbo Pascal *
  137.     *      6.0 would be under the filename TSPA3060.ZIP.        *
  138.     *                                                           *
  139.     *************************************************************
  140.  
  141. Necessary Legalities, etc. (or, how to keep you and I out of court)
  142.  
  143.    By using PRFP, you agree to the following:
  144.  
  145.    The author, Bert Edens, disclaims all warranties, expressed or
  146.    implied, including, without limitation, the warranties of
  147.    merchantability and of fitness for any purpose. The author assumes 
  148.    no liability for damages, direct or consequential,    which may result 
  149.    from the use of PRFP.
  150.  
  151.    PRFP is copyrighted material by Bert Edens.
  152.  
  153.    This product is HungerWare: You may use it for as long as you like 
  154.    without feeling obliged to pay for it. However, the HungerWare comes into 
  155.    play when it helps feed a starving Shareware Author. :) If you were to
  156.    send money, feel free to send whatever you feel PRFP is worth. If you 
  157.    choose to donate, please do so in US funds. If you cannot send money,
  158.    feel free to send a postcard from wherever you call home. Even though
  159.    you are not required to pay for this package, I would still consider 
  160.    "trading" registrations with other shareware authors.
  161.  
  162.    You are allowed to copy and distribute this package, providing that you
  163.    make no charges other than are necessary for copying, materials and 
  164.    handling. The files must not be separated or altered in any way 
  165.    whatsoever including reverse engineering. Use of a hacked or altered 
  166.    version of PRFP is also a violation of said copyright.
  167.  
  168.    There are no registered features to PRFP. The author believes that the
  169.    product could not have registered features without seriously crippling
  170.    the evaluation version. The only benefit you receive is comfort in the
  171.    knowledge that you have helped to keep the shareware concept alive.
  172.  
  173.    The author, Bert Edens, is in no way obliged to give future support for 
  174.    any version of PRFP.
  175.  
  176.    If you don't agree with these rules, you may NOT use PRFP!
  177.  
  178.    Thank you for your support...
  179.